# -*- coding: utf-8 -*-
#
# Sphinx文档构建器的配置文件
#
# 本文件仅包含最常用的选项配置
# 完整选项列表请参考文档:
# http://www.sphinx-doc.org/en/master/config

# -- 路径设置 --------------------------------------------------------------

# 如果扩展模块(或需要使用autodoc记录的模块)位于其他目录
# 请在此处将这些目录添加到sys.path中
# 如果目录相对于文档根目录，请使用os.path.abspath使其成为绝对路径
# 示例如下:
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))


# -- 项目信息 -----------------------------------------------------

project = 'Haiku internals'
copyright = '2021, The Haiku development team'
author = 'The Haiku development team'

# 简短的X.Y版本号
version = ''
# 完整版本号，包括alpha/beta/rc标签
release = ''


# -- 通用配置 ---------------------------------------------------

# 如果你的文档需要最低Sphinx版本，请在此处指定
#
# needs_sphinx = '1.0'

# 在此添加任何Sphinx扩展模块名称(字符串形式)
# 可以是Sphinx自带的扩展('sphinx.ext.*')或自定义扩展
extensions = [
]

# 添加包含模板的路径(相对于本目录)
templates_path = ['_templates']

# 源文件的后缀名
# 可以指定多个后缀(字符串列表形式):
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'

# 主toctree文档
master_doc = 'index'

# Sphinx自动生成内容的语言
# 支持的完整语言列表请参考文档
#
# 如果通过gettext目录进行内容翻译，也会使用此设置
# 通常在这些情况下从命令行设置"language"
language = None

# 匹配文件和目录的模式列表(相对于源目录)
# 在查找源文件时忽略这些模式
# 此模式也会影响html_static_path和html_extra_path
exclude_patterns = []

# 使用的Pygments(语法高亮)样式名称
pygments_style = None


# -- HTML输出选项 -------------------------------------------------

# 用于HTML和HTML帮助页面的主题
# 内置主题列表请参考文档
#
html_theme = 'haiku'

# 主题选项是主题特定的，可进一步自定义主题外观
# 每个主题可用的选项列表请参考文档
#
# html_theme_options = {}

# 在此添加包含自定义静态文件(如样式表)的路径
# 相对于本目录。这些文件会在内置静态文件之后复制
# 因此名为"default.css"的文件将覆盖内置的"default.css"
html_static_path = ['_static']

# 自定义侧边栏模板，必须是映射文档名到模板名的字典
#
# 默认侧边栏(用于不匹配任何模式的文档)
# 由主题本身定义。内置主题默认使用这些模板:
# ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``
#
# html_sidebars = {}


# -- HTMLHelp输出选项 ---------------------------------------------

# HTML帮助构建器的输出文件基本名称
htmlhelp_basename = 'Haikuinternalsdoc'


# -- LaTeX输出选项 ------------------------------------------------

latex_elements = {
    # The paper size ('letterpaper' or 'a4paper').
    #
    # 'papersize': 'letterpaper',

    # The font size ('10pt', '11pt' or '12pt').
    #
    # 'pointsize': '10pt',

    # Additional stuff for the LaTeX preamble.
    #
    # 'preamble': '',

    # Latex figure (float) alignment
    #
    # 'figure_align': 'htbp',
}

# 将文档树分组到LaTeX文件中。元组列表
# (源起始文件, 目标名称, 标题,
#  作者, 文档类[howto, manual或自定义类])
latex_documents = [
    (master_doc, 'Haikuinternals.tex', 'Haiku internals Documentation',
     'The Haiku development team', 'manual'),
]


# -- 手册页输出选项 ------------------------------------------

# 每个手册页一个条目。元组列表
# (源起始文件, 名称, 描述, 作者, 手册部分)
man_pages = [
    (master_doc, 'haikuinternals', 'Haiku internals Documentation',
     [author], 1)
]


# -- Texinfo输出选项 ----------------------------------------------

# 将文档树分组到Texinfo文件中。元组列表
# (源起始文件, 目标名称, 标题, 作者,
#  目录菜单项, 描述, 类别)
texinfo_documents = [
    (master_doc, 'Haikuinternals', 'Haiku internals Documentation',
     author, 'Haikuinternals', 'One line description of project.',
     'Miscellaneous'),
]


# -- Epub输出选项 -------------------------------------------------

# 书目Dublin Core信息
epub_title = project

# 文本的唯一标识符。可以是ISBN号
# 或项目主页
#
# epub_identifier = ''

# 文本的唯一标识
#
# epub_uid = ''

# 不应打包到epub文件中的文件列表
epub_exclude_files = ['search.html']
